The main system of the component. More...
Public Member Functions | |
bool | initialize () |
bool | createDefaultTheme () const |
WindowingSystem * | getWindowingSystem () const |
Clipboard * | getClipboard () const |
ComponentManager * | getComponentManager () const |
CursorManager * | getCursorManager () const |
FontManager * | getFontManager () const |
InputSystem * | getInputSystem () const |
LogManager * | getLogManager () const |
ThemeManager * | getThemeManager () const |
bool | isInitialized () const |
runRoutine | getRunCallback () const |
void | setRunCallback (runRoutine callback) |
void | run () |
void | tick () |
void | prepareForShutdown () |
void | shutdown () |
void | notifyEvent () |
The main system of the component.
Used to boot the component, and then automate some functionalities like the program loop. The system can be used as a Singleton, or as an isolated instance. For most cases, the Singleton usage should be sufficient. However, if another totally isolated system is needed for a limited lifetime, it can be instantiated elsewhere. Do note that depending on the WindowingSystem used, while the created resources will be isolated, the underlying used API might be in a common context.
bool nkWinUi::MainSystem::initialize | ( | ) |
Initialization of the component. Has to be called before being able to use the component.
bool nkWinUi::MainSystem::createDefaultTheme | ( | ) | const |
Creates the default theme. Part of the initialization routine.
WindowingSystem* nkWinUi::MainSystem::getWindowingSystem | ( | ) | const |
Clipboard* nkWinUi::MainSystem::getClipboard | ( | ) | const |
ComponentManager* nkWinUi::MainSystem::getComponentManager | ( | ) | const |
CursorManager* nkWinUi::MainSystem::getCursorManager | ( | ) | const |
FontManager* nkWinUi::MainSystem::getFontManager | ( | ) | const |
InputSystem* nkWinUi::MainSystem::getInputSystem | ( | ) | const |
LogManager* nkWinUi::MainSystem::getLogManager | ( | ) | const |
ThemeManager* nkWinUi::MainSystem::getThemeManager | ( | ) | const |
bool nkWinUi::MainSystem::isInitialized | ( | ) | const |
runRoutine nkWinUi::MainSystem::getRunCallback | ( | ) | const |
void nkWinUi::MainSystem::setRunCallback | ( | runRoutine | callback | ) |
Sets the callback for the running loop. This callback is called when the run() function is used, whenever the loop has done a tick.
callback | The callback to use. |
void nkWinUi::MainSystem::run | ( | ) |
Enters the running loop, until the program is ended.
void nkWinUi::MainSystem::tick | ( | ) |
If the running loop has to be run by external code, this function can be called within that function to tick the windowing system. Ticking comprises event handling, for instance.
void nkWinUi::MainSystem::prepareForShutdown | ( | ) |
Prepares the component for shutdown. Has to be calkled before shutdown().
void nkWinUi::MainSystem::shutdown | ( | ) |
Shuts the component, typically when the program ends.
void nkWinUi::MainSystem::notifyEvent | ( | ) |
Fire an empty message to force an event down the system. Can be used in the running context to force a tick to occur, as depending on the windowing system it can wait for events before ticking.